/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.search.solr;

/**
 * Utilities for building and analyzing Solr queries.
 */
public class CmsSolrQueryUtil {

    /** The prefix to distinguish a Geo filter query from other filter queries. */
    public static final String GEO_FILTER_QUERY_PREFIX = "{!geofilt";

    /**
     * Composes a Geo filter query string for given parameters.
     * @param fieldName the field name
     * @param coordinates the coordinates
     * @param radius the search radius
     * @param units the units of the search radius
     * @return the Geo filter query string
     */
    public static String composeGeoFilterQuery(String fieldName, String coordinates, String radius, String units) {

        return GEO_FILTER_QUERY_PREFIX
            + " sfield="
            + fieldName
            + " pt="
            + coordinates
            + " d="
            + radius
            + " units="
            + units
            + "}";
    }
}
